-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
JuliaFormatter & workflow #482
Conversation
Codecov Report
@@ Coverage Diff @@
## master #482 +/- ##
==========================================
+ Coverage 92.92% 93.00% +0.07%
==========================================
Files 15 15
Lines 791 800 +9
==========================================
+ Hits 735 744 +9
Misses 56 56
Continue to review full report at Codecov.
|
I think we want to follow BlueStyle? By default, JuliaFormatter uses its own style, not BlueStyle. Can you check in a Also, now would be a good time to add the BlueStyle badge to the ReadMe. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not review the .yml
file.
IMO overall this is an improvement in readability, and I am ok to accept formatter dictatorship on a few cases where the current way of writing (e.g. aligning vertically) is more readable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks nice work.
We need to look at it again once it has been set to BlueStyle.
Sure. In the end, I think it's more important to have an automatic formatter than what the style is, exactly.:) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
personally, i am against having a formatter CI job, because in my experience it is more pain than it is worth (and i say that as both the biggest contributor to BlueStyle and the person who worked with Dom to have it added to JuliaFormatter.jl). But i am not one of the bigger contributors here so am happy enough to be out voted
I am neutral about running the formatter as a one-off over the existing code (it makes style a bit more consistent but interferes with gt blame), but if we are to do that we should use BlueStyle only (whereas this PR currently includes changes that makes the style "worse" (according to BlueStyles) because it also includes changes made first be a different style, so i think those should be removed before this is merged
Personally, in my experience the pain from dealing with the autoformatter is much smaller than all the pain from arguments about style that are completely removed by having the autoformatter. But of course also happy for the core maintainers to vote as they see fit!
We can simply remove the formatter workflow from this PR again and just keep the formatting changes if you want to do that:)
A bit, but it's easy enough to "blame previous to this commit" (in the GitHub UI even easier than on the commandline):)
I've now removed all the changes from the previous format run, so its current state is BlueStyle changes only. |
Co-authored-by: Lyndon White <[email protected]>
Tangent{Tuple{Float64,Float64}}(4.0, 8.0) == | ||
Tangent{Tuple{Float64,Float64}}(2.0, 4.0) * 2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this change is required by BlueStyle.
But I don't think it is forbidden either,
It is fine
OK, this worked out better than I initially expected seeing the PR. I think we can merge this once the outstanding comments are solved. Excellent. Very nice work |
Co-authored-by: Lyndon White <[email protected]>
Co-authored-by: Lyndon White <[email protected]>
Looks like the reviewdog doesn't actually make the suggestion for how to fix a line (so you could simply accept the review suggestion, instead of having to fix it manually). Not sure why that is - github actions permissions lacking ? |
thanks |
Resolves #462. Supersedes #463.